Documentation

Secular

MIT Latest Version Chat on Miaou

Provide a lowercased diacritics-free version of a character.

For example return e for é.

Secular's char lookup is an inlined lookup of a static table, which means it's possible to use it in performance sensitive code.

Declaration

Secular declares 2 exclusive features resulting in char mapping tables of different sizes: "ascii" and "bmp".

For ASCII:

[dependencies]
secular = "0.2"

For more characters (the BMP):

[dependencies]
secular = { version="0.2", default-features=false, features=["bmp"] }

With Unicode normalization functions (using the unicode-normalization crate):

[dependencies]
secular = { version="0.2", features=["normalization"] }

or

[dependencies]
secular = { version="0.2", default-features=false, features=["bmp","normalization"] }

This feature is optional so that you can avoid importing the unicode-normalization crate (note that it's used in many other crates so it's possible your text processing application already uses it).

Usage

On characters:

use secular::*;
    let s = "Comunicações"; // normalized string (length=12)
    let chars: Vec<char> = s.chars().collect();
    assert_eq!(chars.len(), 12);
    assert_eq!(chars[0], 'C');
    assert_eq!(lower_lay_char(chars[0]), 'c');
    assert_eq!(chars[8], 'ç');
    assert_eq!(lower_lay_char(chars[8]), 'c');

On strings:

use secular::*;
let s = "Comunicações"; // unnormalized string (length=14)
    assert_eq!(s.chars().count(), 14);
    let s = normalized_lower_lay_string(s);
    assert_eq!(s.chars().count(), 12);
    assert_eq!(s, "comunicacoes");